/**
 *    Copyright (C) 2008, 2009  Victor Smirnov <aist11@gmail.com>
 *
 *    This program is free software; you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation; either version 3 of the License, or
 *    (at your option) any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License along
 *    with this program; if not, write to the Free Software Foundation, Inc.,
 *    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 *    See LICENSE.exceptions in the root folder of this project for possible
 *    exceptions
 *
 */

#ifndef _CUBEFS_API_COLLECTIONS_MAP_HPP
#define	_CUBEFS_API_COLLECTIONS_MAP_HPP

#include <cubefs/api/models/collection.hpp>

namespace cubefs    {
namespace api       {

struct CUBEFS_API Map: public Collection {
    
    struct CUBEFS_API Pair: public Typed {
        virtual Typed *key() const  		= 0;
        virtual Typed *value() const 		= 0;
        virtual Int GetIdx() const 			= 0;
        virtual void SetIdx(Int idx) 		= 0;
        virtual void CheckKeyNotNull() 		= 0;
        virtual void CheckValueNotNull()	= 0;
        virtual void CheckKVNotNull() 		= 0;

        static Type* MyType();
    };

    virtual bool Get(Pair* pair)            = 0;
    virtual void Put(Pair* pair)            = 0;
    virtual bool Remove(Pair *key)          = 0;

    virtual Iterator* Find(Pair *pair)      = 0;

    virtual Pair* CreatePairHolder()        = 0;

    static Type* MyType();
};


CUBEFS_DECLARE_TYPENAME(Map,        "cubefs::api::models::Map");
CUBEFS_DECLARE_TYPENAME(Map::Pair,  "cubefs::api::models::Map::Pair");


}
}

#endif
